home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-05 / pe300ai.zip / PE300AI.DOC < prev    next >
Text File  |  1993-07-27  |  10KB  |  311 lines
  1. AI-LANBIOS Low-Level Driver For PE-300 Pocket Ethernet Adapters (PE300AI.DOC)
  2.           --------------------------------------------------
  3.                    (C) Copyright 1993 ARTISOFT, Inc.
  4.                           (Revised 6/8/93)
  5.  
  6. INTRODUCTION
  7. ============
  8.  
  9. The PE300AI.EXE low-level AI-LANBIOS driver allows you to use your 
  10. PE-300B,PE-300T Pocket Ethernet adapters in a LANtastic network.
  11.  
  12. In order for the PE-300B and PE-300T Pocket Ethernet adapter to function
  13. with the LANtastic Network Operating System (NOS), you must first install
  14. the adapter as instructed in your adapter guide, then run the supporting
  15. software (PE300AI.EXE and AILANBIO.EXE).  PE300AI.EXE communicates
  16. with the adapter, while AILANBIO.EXE provides high-level communications
  17. across the local area network.  Because of this, you cannot run any
  18. network software until after you load PE300AI.EXE and AILANBIO.EXE.
  19. (Note: For information on running AILANBIO.EXE, refer to AILANBIO.DOC
  20. on your LANtastic driver diskette.)
  21.  
  22. There are command line switches that you can use when you run PE300AI.EXE
  23. and AILANBIO.EXE.  These switches allow you greater flexibility in using
  24. these programs.  For information on the AILANBIO.EXE command line options
  25. refer to AILANBIO.DOC on your LANtastic driver disk.  For information on
  26. PE300AI.EXE command line switches, refer to "PE300AI.EXE COMMAND LINE OPTIONS"
  27. in this file.
  28.  
  29.  
  30. RUNNING PE300AI.EXE
  31. ===================
  32.  
  33. The syntax for running PE300AI.EXE is
  34.  
  35.      PE300AI[switches . . . ] [ ; comment]
  36.  
  37. where "switches" denotes any optional command line switches.  If you are
  38. using more than one switch in a command line, use a space or a forward
  39. slash (/) to separate the arguments.  If a switch takes a value (such as
  40. when you designate the DOS multiplex number with the MPX= switch) the
  41. switch must be followed by an equal sign (=) or a colon (:).  All switch
  42. values are checked to make sure they are valid.  Illegal values produce
  43. error messages.
  44.  
  45. These are valid switch formats:
  46.  
  47.         SWITCH
  48.         /SWITCH
  49.         SWITCH:VALUE
  50.         /SWITCH=VALUE
  51.  
  52. You would use one of the first two formats for a switch that does not take
  53. a value.  For example:
  54.  
  55.         PE300AI/HELP
  56.  
  57. You would use the third or fourth formats for a switch that takes a value.
  58. Such as:
  59.  
  60.         PE300AI/MPX=D7
  61.  
  62.  
  63. PE300AI.EXE COMMAND LINE OPTIONS
  64. ================================
  65.  
  66. The valid PE300AI.EXE switches appear below.  The letters "ddd"  denote
  67. that you must provide a decimal number.  The letters "hh" denote a
  68. required hexadecimal value.  Values enclosed in brackets "[]" indicate
  69. default values if the switch is omitted.  Values after the brackets denote
  70. the valid range of variables for the switch.
  71.  
  72. ----------
  73.     @switch-file
  74.  
  75. This option specifies that further switches are to be taken from a
  76. switch file.  Any switches after the @switch-file name will be used,
  77. and the switch settings take precedence over any settings in the switch
  78. file.  You may invoke switch files from within switch files as often as
  79. you wish.  The file should contain valid switches and may contain comment
  80. characters (;) at the beginning of each line or after switches.
  81.  
  82. For example,
  83.  
  84.      PE300AI @setup
  85.  
  86. The file SETUP contains
  87.  
  88.      ; PE300AI AI-LANBIOS driver setup file
  89.      ;
  90.      MPX=D7            ; Use Multiplex number D7
  91.      
  92.  
  93. ----------
  94.      HELP or ?
  95.  
  96. This switch instructs PE300AI.EXE to display information about the valid
  97. command line switches, but does not install the PE300AI.EXE driver.  For
  98. example,
  99.  
  100.      PE300AI/help
  101.      PE300AI ?
  102.  
  103. See the messages section for a detailed description of the HELP display
  104. output.
  105.  
  106. ----------
  107.      MPX=hh [C7] C0-FF
  108.  
  109. This switch specifies the DOS multiplex (MPX) number to use for
  110. communication with AILANBIO.EXE.  You will need to change this value only
  111. if the default MPX number is in use by another application or NETBIOS.
  112. Multiplex numbers 00 through BF are reserved for DOS use; therefore, you
  113. must use a multiplex number between C0 and FF.
  114.  
  115. ----------
  116.      PACKET_SIZE=dddd [1500] 600-1500
  117.  
  118. This switch specifies the maximum size of transmitted IEEE 802.3 packets.
  119. You may need to change this value when using certain bridges that do not
  120. support the full 1500-byte packet size.  Even when you reduce the packet
  121. size, the low-level driver can still receive larger packets.
  122.  
  123. ----------
  124.     REMOVE
  125.  
  126. This switch removes PE300AI.EXE from memory.  You must remove TSR programs
  127. in the opposite order they were loaded.  For example, if you loaded
  128. PE300AI.EXE and then AILANBIO, you must remove AILANBIO before PE300AI.EXE
  129. In addition, if you have more than one invocation of PE300AI.EXE and
  130. AILANBIO you must use the MPX= switch on the command line to specify which
  131. copy of PE300AI.EXE but not (AILANBIO) that you want to unload.  For
  132. example, if you load two copies of PE300AI.EXE and AILANBIO:
  133.  
  134. PE300AI.EXE/MPX=C7
  135. AILANBIO/ADAPTER=0/MPX=C7
  136. PE300AI.EXE/MPX=D7
  137. AILANBIO/ADAPTER=1/MPX=D7
  138.  
  139. To unload these copies of PE300AI.EXE and AILANBIO:
  140.  
  141. AILANBIO/REMOVE
  142. PE300AI.EXE/MPX=D7/REMOVE
  143. AILANBIO/REMOVE
  144. PE300AI.EXE/MPX=C7/REMOVE
  145.  
  146. The REMOVE option will remove the most recently run copy of AILANBIO.
  147.  
  148. ---------
  149.      XEROX
  150.  
  151. This switch causes all transmitted packets to be in the XEROX format
  152. instead of the IEEE 802.3 standard.
  153.  
  154. ---------
  155.      IEEE
  156.  
  157. This switch causes all transmitted packets to be in the IEEE 802.3 format
  158. instead of the XEROX standard.
  159.  
  160.  
  161.  
  162. PE300AI.EXE MESSAGES
  163. ====================
  164.  
  165. The PE300AI.EXE driver produces two types of messages: Informative and
  166. Error.  All error messages are preceded by the text "ERROR:" and in those
  167. cases the PE300AI.EXE driver is not installed.
  168.  
  169.  
  170. --------
  171. MESSAGE:
  172.  
  173. PE-300 Ethernet Adapter AI-LANBIOS(R) Compatible Driver V4.xx (xxxxxx KCI)
  174.  
  175. This message is displayed each time the low-level driver is invoked.
  176.  
  177. --------
  178. MESSAGE:
  179.             ---- AI-LANBIOS Compatible driver installed ----
  180.  
  181. This message is displayed after the low-level driver is successfully
  182. installed. 
  183.  
  184. --------
  185. MESSAGE:
  186.             ---- AI-LANBIOS Compatible driver NOT installed ----
  187.  
  188. This message is displayed if the low-level driver is not installed.  The
  189. driver will not be installed if HELP information is displayed or an error
  190. occurred.
  191.  
  192. --------
  193. MESSAGE:
  194.  
  195. Valid command line switches:
  196.     HELP
  197.     XEROX
  198.     IEEE
  199.     MPX= Range C0 to FF hex 
  200.     PACKET_SIZE= Range 600 to 1500 decimal 
  201.     REMOVE
  202.     ?
  203.     @ Range 0 to 2048 byte file 
  204.  
  205. This message is displayed when the HELP or ? switch is used.  Each valid
  206. switch is listed with the acceptable range of values (if any) and the base
  207. (hex or decimal) that the numbers must be entered in.  The acceptable file
  208. size range for indirect files (@) is also listed.
  209.  
  210. --------
  211. MESSAGE:
  212.  
  213. AI-LANBIOS Compatible Driver is not loaded
  214.  
  215. You have issued the PE300AI/REMOVE command and do not have PE300AI.EXE
  216. loaded into memory.  Only issue this command after the program is loaded.
  217.  
  218. -------
  219. MESSAGE:
  220.  
  221.             ---- AI-LANBIOS Compatible driver REMOVED ----
  222.  
  223. The PE300AI.EXE driver has been removed from memory.
  224.  
  225. -------
  226. ERROR:    Can't REMOVE -- AI-LANBIOS(R) still installed
  227.  
  228. Meaning:  You have attempted to remove PE300AI.EXE and the interrupts are
  229.           in use by another TSR, or PE300AI.EXE was not the last TSR
  230.           loaded.
  231.  
  232. Remedy:   Remove any TSRs loaded after PE300AI.EXE.  For example, if you
  233.           load PE300AI.EXE then AILANBIO.EXE, you must first remove
  234.           AILANBIO.EXE, then you can remove PE300AI.EXE.
  235.  
  236. -------
  237. ERROR:    Installed AI-LANBIOS Compatible Drivers is different version
  238.  
  239. Meaning:  You have loaded a version of the PE300AI.EXE program and
  240.           attempted to remove it from memory with the /REMOVE switch.  The
  241.           version with which you are attempting to remove PE300AI.EXE is
  242.           not the same version that was loaded.
  243.  
  244. Remedy:   Remove PE300AI.EXE with the same version of the program that was
  245.           loaded.
  246.  
  247. ------
  248. ERROR:   Cannot open switch file - @file
  249.  
  250. Meaning: The file "file" cannot be opened as an switch file.
  251.  
  252. Remedy:  The file must exist before it can be used as an switch file.
  253.  
  254. ------
  255. ERROR:   Illegal switch - ??????=nnnn
  256.  
  257. Meaning: The switch ??????=nnnn is not a recognized switch.
  258.  
  259. Remedy:  You may only specify legal switches on the command line.
  260.  
  261. ------
  262. ERROR:   MPX number hh is already in use - Try another number
  263.  
  264. Meaning: The multiplex (MPX) interrupt number hh is being used by another
  265.          application or low-level driver.
  266.  
  267. Remedy:  Try another MPX number.
  268.  
  269. ------
  270. ERROR:   No Pocket Ethernet Adapter found or defective Adapter.
  271.  
  272. Meaning: PE300AI.EXE did not find an adapter or the Pocket Ethernet
  273.          Adapter is probably defective.
  274.  
  275. Remedy:  Make sure the adapter is correctly installed and power is connected.
  276.  
  277. ------
  278. ERROR:   Switch value not in range - ??????=nnnn
  279.          Valid range is ssss to eeee
  280.  
  281. Meaning: The value nnnn is not in proper range.  The value "ssss"
  282.          represents the lowest acceptable value and the value "eeee"
  283.          represents the highest acceptable value.
  284.  
  285. Remedy:  Limit your range of values to the acceptable range.
  286.  
  287. ------
  288. ERROR: Invalid Pocket Ethernet Adapter (KCI)
  289.        It might damage your adapter and network !
  290.  
  291. Meaning: The Pocket Ethernet Adapter is probably defective.
  292.  
  293.  
  294.  
  295. TESTING PE300AI.EXE RETURN CODES (ERROR LEVELS)
  296. ==============================================
  297.  
  298. You may test the PE300AI.EXE return code or error level in a batch file by
  299. using the IF ERRORLEVEL command.  The following error levels are returned:
  300.  
  301.      0     No error encountered.  PE300AI.EXE driver installed
  302.      1     MPX number is in use
  303.      2     Switch error
  304.      3     No PE-300B or PE-300T present
  305.      4     PE300AI.EXE driver not loaded
  306.      5     Can't remove, different PE300AI.EXE version loaded
  307.      6     Cannot remove, interrupts re-hooked
  308.      7     ERROR: Can't REMOVE -- AI-LANBIOS (R) still installed
  309.  
  310. 
  311.